/*=========================================================================
 Copyright (c) 2008, Nokia Corporation and/or its subsidiary(-ies).
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
     * Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
     * Neither the name of the Nokia Corporation and/or its subsidiary(-ies)nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================================*/

#ifndef _ncvComparisionOp_H_
#define _ncvComparisionOp_H_

#include "ncvImage.h"

/**
 * \class CComparisonOp
 * \brief Provides CNokiaCVImage with pixel-wise image comparison operations: "greater than", "less than" and "equal".
 * 
 * Matching pixels are set white. Non-matching and pixels outside the comparison region are set black.
 * Also pixels that were outside smaller compared bitmap are set black.
 *
 * \note Symbian TClass.
 */
class CComparisonOp : public CImageOp
	{
public:
	/**
	 * \enum TComparisonType
	 * \brief Comparison operation
	 *
	 * Valid values are:
	 *	- EGreater
	 *	- ELess
	 *	- EEqual
	 * \note Symbian TClass.
	 */
	IMPORT_C enum TComparisonType
		{
		EGreater,
		ELess,
		EEqual
		};

	/**
	 * \brief Constructor.
	 * \param aImage1 images to compare
	 * \param aImage2 another images to compare.
	 * \param aComparison Comparison operation: .EGreater, ELess or EEqual
	 * \note These two images must be of same bit depth and same size
	 */
	IMPORT_C CComparisonOp( CNokiaCVImage* aImage1, CNokiaCVImage* aImage2, TComparisonType aComparison );

	/**
	 * \brief Constructor.
	 * \param aImage1 images to compare
	 * \param aImage2 another images to compare. These two images must be of same bit depth and same size
	 * \param aComparison Comparison operation: .EGreater, ELess or EEqual
	 * \param aSubregion subregion of images 1 and 2 that are compared
	 * \note These two images must be of same bit depth and same size
	 */
	IMPORT_C CComparisonOp( CNokiaCVImage* aImage1, CNokiaCVImage* aImage2, TComparisonType aComparison, TRect aSubregion );

	/**
	 * \brief Do the operation.
	 * \param aTarget CNokiaCVImage to store the result in. The target bitmap must be black and white. The target bitmap
	 * must be created before calling this,
	 * \note the function can leave
	 */
	IMPORT_C void DoOperation( CNokiaCVImage* aTarget );

private:
	void NormalCompareL(CNokiaCVImage* aTarget);
	void SubregionCompareL(CNokiaCVImage* aTarget);

	CNokiaCVImage*		iImage1;
	CNokiaCVImage*		iImage2;
	TComparisonType	iOperation;
	TRect			iRegion;

    TUint32 ON;
    TUint32 OFF;

	};

#endif
